[kyb] add issuing authority to IDs#480
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✱ Stainless preview builds for gridThis PR will update the cli csharp go kotlin openapi php python ruby typescript
|
Greptile SummaryThis PR adds an optional
Confidence Score: 4/5Safe to merge — the changes are additive optional fields on existing schemas with no breaking API surface changes. The two schemas that are actually wired into the API (BeneficialOwnerPersonalInfo and BeneficialOwnerPersonalInfoUpdate) are correctly updated and the bundles are regenerated. The only wrinkle is PersonalIdentification.yaml, which receives the same field but is not referenced by any other schema, so its update has no effect on the published spec. PersonalIdentification.yaml — it's unclear whether this schema is intentionally a standalone stub or was meant to be shared via $ref across the beneficial-owner schemas.
|
| Filename | Overview |
|---|---|
| openapi/components/schemas/customers/PersonalIdentification.yaml | Adds issuingAuthority field, but this schema is not referenced anywhere in the OpenAPI source or bundle, so the change has no effect on the published API spec. |
| openapi/components/schemas/customers/BeneficialOwnerPersonalInfo.yaml | Adds optional issuingAuthority string field to the beneficial-owner personal info schema; field is correctly not added to required, consistent with PR intent. |
| openapi/components/schemas/customers/BeneficialOwnerPersonalInfoUpdate.yaml | Adds optional issuingAuthority string field to the update schema; mirrors the create schema change and is correctly optional. |
| openapi.yaml | Generated bundle — issuingAuthority correctly appears in BeneficialOwnerPersonalInfo and BeneficialOwnerPersonalInfoUpdate sections after make build. |
| mintlify/openapi.yaml | Mintlify copy of the generated bundle — changes mirror openapi.yaml, both are correctly regenerated. |
Sequence Diagram
sequenceDiagram
participant Dashboard
participant GridAPI as Grid API
participant Spec as OpenAPI Spec
Note over Spec: BeneficialOwnerPersonalInfo + issuingAuthority (optional)
Note over Spec: BeneficialOwnerPersonalInfoUpdate + issuingAuthority (optional)
Dashboard->>GridAPI: "POST /beneficial-owners { personalInfo: { issuingAuthority: ... } }"
GridAPI-->>Dashboard: 201 Created
Dashboard->>GridAPI: "PATCH /beneficial-owners/{id} { personalInfo: { issuingAuthority: ... } }"
GridAPI-->>Dashboard: 200 OK
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 1
openapi/components/schemas/customers/PersonalIdentification.yaml:16-19
`PersonalIdentification.yaml` appears to be unreferenced — searching the entire `openapi/` directory (and the bundled `openapi.yaml` / `mintlify/openapi.yaml`) returns no `$ref` pointing to this schema. That means the `issuingAuthority` field added here won't surface in the generated API spec at all. If this schema is intentionally a "stub" for future use, it's fine to leave it, but the change has no current effect on the API surface. If it was expected to be the canonical definition shared by the beneficial-owner schemas, those schemas would need to reference it via `$ref` instead of inlining the identification fields.
Reviews (1): Last reviewed commit: "[kyb] add issuing authority to IDs" | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| issuingAuthority: | ||
| type: string | ||
| description: Name of the government agency or organization that issued the identification | ||
| example: U.S. Department of State |
There was a problem hiding this comment.
PersonalIdentification.yaml appears to be unreferenced — searching the entire openapi/ directory (and the bundled openapi.yaml / mintlify/openapi.yaml) returns no $ref pointing to this schema. That means the issuingAuthority field added here won't surface in the generated API spec at all. If this schema is intentionally a "stub" for future use, it's fine to leave it, but the change has no current effect on the API surface. If it was expected to be the canonical definition shared by the beneficial-owner schemas, those schemas would need to reference it via $ref instead of inlining the identification fields.
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/customers/PersonalIdentification.yaml
Line: 16-19
Comment:
`PersonalIdentification.yaml` appears to be unreferenced — searching the entire `openapi/` directory (and the bundled `openapi.yaml` / `mintlify/openapi.yaml`) returns no `$ref` pointing to this schema. That means the `issuingAuthority` field added here won't surface in the generated API spec at all. If this schema is intentionally a "stub" for future use, it's fine to leave it, but the change has no current effect on the API surface. If it was expected to be the canonical definition shared by the beneficial-owner schemas, those schemas would need to reference it via `$ref` instead of inlining the identification fields.
How can I resolve this? If you propose a fix, please make it concise.
| type: string | ||
| description: Country that issued the identification (ISO 3166-1 alpha-2) | ||
| example: US | ||
| issuingAuthority: |
There was a problem hiding this comment.
Should this be required?
There was a problem hiding this comment.
it will be in the future (https://lightspark.atlassian.net/browse/AT-5270), but I want to add it to the dashboard first and test while it's still optional
Reverts #480 oops. realized we want this on the document object, not on the beneficial owner
2 participants
As part of our bank's customer onboarding, we need to provide the issuing authority on all customer IDs -- these changes add that field to the API so we can begin dashboard work on collecting it. Future changes will make it a required field
closes https://lightspark.atlassian.net/browse/AT-4816